Initializes a new instance of the KsCommandStatus<T> class.
Namespace: IntervalZero.KINGSTAR.Base.ApiAssembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0
Syntax
public KsCommandStatus<T>(
ulong handle
int valueLength
int inSyncLatch
bool done
bool inSync
bool inVelocity
bool busy
bool active
bool commandAborted
bool error
KsError errorId
T value
)Public Sub New(
handle As ULong
valueLength As Integer
inSyncLatch As Integer
done As Boolean
inSync As Boolean
inVelocity As Boolean
busy As Boolean
active As Boolean
commandAborted As Boolean
error As Boolean
errorId As KsError
value As T
)Parameters
handle
Type: ulong
Used to uniquely identify a command. You can pass the KsCommandStatus.Handle to the constructor when you create a command.
valueLength
Type: int
The length of the value buffer. You can pass the KsCommandStatus.ValueLength to the constructor when you create a command.
inSyncLatch
Type: int
Gets or stores a command's specific value. You can pass the KsCommandStatus.InSyncLatch to the constructor when you create a command.
done
Type: bool
The method has done its work. You can pass the KsCommandStatus.Done to the constructor when you create a command.
inSync
Type: bool
true: The synchronization is completed. false: The slave axis is synchronizing with the master axis. You can pass the KsCommandStatus.InSync to the constructor when you create a command.
inVelocity
Type: bool
The commanded velocity reached. You can pass the KsCommandStatus.InVelocity to the constructor when you create a command.
busy
Type: bool
The method is not finished and new output values are to be expected. You can pass the KsCommandStatus.Busy to the constructor when you create a command.
active
Type: bool
The method is controlling the axis. You can pass the KsCommandStatus.Active to the constructor when you create a command.
commandAborted
Type: bool
The command is aborted by another command. You can pass the KsCommandStatus.CommandAborted to the constructor when you create a command.
error
Type: bool
Signals that an error has occurred within the method. You can pass the KsCommandStatus.Error to the constructor when you create a command.
errorId
Type: KsError
The error identification. You can pass the KsCommandStatus.ErrorId to the constructor when you create a command.
value
Type: T
The value returned by a method. Its type depends on the method. You can pass the KsCommandStatus<T>.Value or your desired value to the constructor when you create a command.
See also